home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 7: Sunsite / Linux Cubed Series 7 - Sunsite Vol 1.iso / system / shells / zsh-3.0-p / zsh-3 / zsh-3.0-pre3 / README < prev    next >
Text File  |  1996-06-28  |  6KB  |  127 lines
  1. $Id: README,v 2.3 1996/06/28 13:29:59 hzoli Exp $
  2.  
  3. Version
  4. -------
  5. This is zsh version 3.0
  6.  
  7. Installing Zsh
  8. --------------
  9. The instructions for compiling zsh are in the file INSTALL.  You should
  10. also check the file MACHINES in the subdirectory Etc to see if there
  11. are any special instructions for your particular architecture.
  12.  
  13. If compilation fails in builtin.c with the message
  14.     `there are some unknown limits.  Fix me!'
  15. then please try to locate the header file where the RLIMIT_ macros are
  16. defined on your system (it is usually in /usr/include/sys/resource.h)
  17. and send this file and the manchine and OS type you are using to
  18. zsh-workers@math.gatech.edu.
  19.  
  20. Features
  21. --------
  22. Zsh is a shell with lots of features.  For a list of these, see the
  23. file Etc/FEATURES.  For more details, see the documentation.
  24.  
  25. Documentation
  26. -------------
  27. There are a number of documents about zsh in this distribution:
  28.  
  29. Doc/zsh*.man    Man pages in nroff format.  These will be installed
  30.         by "make install.man" or "make install".  By default,
  31.         these will be installed in /usr/local/man/man1, although
  32.         you can change this with the --mandir option to configure
  33.         or editing the user configuration section of the top level
  34.         Makefile.
  35.  
  36. Doc/zsh.texi    Everything the man pages have, but in texinfo format.  These
  37.         will be installed by "make install.info" or "make install".
  38.         By default, these will be installed in /usr/local/info,
  39.         although you can change this with the --infodir option to
  40.         configure or editing the user configuration section of the
  41.         top level Makefile.
  42.  
  43. Also include in the distribution are:
  44.  
  45. Doc/intro.ms    An introduction to zsh in troff format using the ms
  46.         macros.  This document explains many of the features
  47.         that make zsh more equal than other shells.
  48.         Unfortunately this is based on zsh-2.5 so some examples
  49.         may not work without changes but it is still a good
  50.         introduction.
  51.  
  52. If you do not have the necessary tools to process these documents,
  53. postscript, and ascii, info and dvi versions are available in the
  54. separate file zsh-doc.tar.gz at the archive sites listed below.
  55.  
  56. The distribution also contains a perl script in Utils/helpfiles which
  57. can be used to extract the descriptions of builtin commands from the
  58. zshbuiltin manual page.  See the comments at the beginning of the script
  59. about its usage.  The files created by this script can be used by
  60. example function run-help located in the subdirectory Functions to show
  61. information about zsh builtins and run `man' on external commands.  For
  62. this the shell variable HELPDIR should point to a directory containing
  63. the fileles generated by the helpfiles script.  run-help should be
  64. unaliased before loading the run-help function.  After that this
  65. function will be executed by the run-help ZLE function which is by
  66. default bound to ESC-h in emacs mode.
  67.  
  68. Examples
  69. --------
  70. Examples of zsh startup files are located in the subdirectory
  71. StartupFiles.  Examples of zsh functions and scripts are located in
  72. the subdirectory Functions.  Examples of completion control commands
  73. (compctl) are located in the file Misc/compctl-examples.
  74.  
  75. Zsh Ftp Sites, Web Pages, and Mailing Lists
  76. -------------------------------------------
  77. The current list of zsh ftp sites, web pages, and mailing lists can be
  78. found in the META-FAQ.  A copy is included in this distribution and is
  79. available separately at any of the zsh ftp sites.
  80.  
  81. Common Problems and Frequently Asked Questions
  82. ----------------------------------------------
  83. Zsh has a list of Frequently Asked Questions (FAQ) maintained by
  84. Peter Stephenson <P.Stephenson@swansea.ac.uk>.  It covers many common
  85. problems encountered when building, installing, and using zsh.  A copy
  86. is included in this distribution in Etc/FAQ and is available separately
  87. at any of the zsh ftp sites.
  88.  
  89. Zsh Maintenance and Bug Reports
  90. -------------------------------
  91. Zsh is currently maintained by the members of the zsh-workers mailing list
  92. and coordinated by Zoltßn HidvΘgi <hzoli@cs.elte.hu>.  Please send
  93. any feedback and bugs reports to: zsh-workers@math.gatech.edu
  94.  
  95. There is a script "reporter" in the subdirectory Util which will print
  96. out your current shell environment/setup.  If you report a bug, please
  97. use this script and include the output from sourcing this file.  This way,
  98. the problem you are reporting can be recreated.
  99.  
  100. You can help even more if you can reproduce the bug starting zsh with
  101. the -f option.  This skips the execution of local startup files except
  102. /etc/zshenv.  If a bug occurs only when some options set try to locate
  103. the option which triggers the bug.
  104.  
  105. The known bugs in zsh are listed in the file Etc/BUGS.  Check this as
  106. well as the Frequently Asked Questions (FAQ) list before sending a bug
  107. report.  Note that zsh has some features which are not compatible with
  108. sh but these are not bugs.  Most of these incompatibilities go away
  109. when zsh is invoked as sh or ksh (e.g. using a symbolic link).
  110.  
  111. If you send a bug report to the list and are not a subscriber, please
  112. mention this in your message if you want a response.
  113.  
  114. If you would like to contribute to the development and maintenance of zsh,
  115. then you should join the zsh-workers mailing list (check the META-FAQ
  116. for info on this).  You should also read the "zsh-development-guide"
  117. located in the subdirectory Util.
  118.  
  119. Contributors
  120. ------------
  121. The people who have contributed to this software project are listed
  122. in Etc/CONTRIBUTORS.
  123.  
  124. -------------------------------------------------------------
  125. Zoltßn HidvΘgi          (Coordinator, Zsh Development Group)
  126. hzoli@cs.elte.hu
  127.